/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.basics.process;

import java.util.Comparator;

import org.springframework.core.OrderComparator;
import org.springframework.util.comparator.ComparableComparator;
import org.springframework.util.comparator.InvertibleComparator;

import com.genia.toolbox.basics.bean.ArrayComparator;

/**
 * Static class containing comparators.
 */
public class Comparators
{

  /**
   * constructor.
   */
  private Comparators()
  {
    // Do nothing
  }

  /**
   * {@link Comparator} that used the {@link org.springframework.core.Ordered}
   * interface.
   */
  @SuppressWarnings("unchecked")
  public static final Comparator<Object> ORDERED_COMPARATOR = new OrderComparator();

  /**
   * {@link Comparator} that used the {@link Comparable} interface.
   */
  @SuppressWarnings("unchecked")
  public static final Comparator<Comparable> NATURAL_COMPARATOR = new ComparableComparator();

  /**
   * {@link Comparator} that used the {@link Comparable} interface and inverse
   * the natural order.
   */
  @SuppressWarnings("unchecked")
  public static final Comparator<Comparable> INVERSE_NATURAL_COMPARATOR = new InvertibleComparator(NATURAL_COMPARATOR, false);

  /**
   * {@link Comparator} that compare arrays.
   */
  public static final Comparator<Comparable<?>[]> NATURAL_ARRAY_COMPARATOR = new ArrayComparator<Comparable<?>>(NATURAL_COMPARATOR);

}
